feat(core): add ZILLIZ_PROJECT_NAME environment variable for configurable project name#203
Open
RauchenwaldC wants to merge 1 commit intozilliztech:masterfrom
Open
Conversation
…able project name - Add support for ZILLIZ_PROJECT_NAME environment variable to configure Zilliz Cloud project name - Update getAddressFromToken method to use configurable project name with fallback to 'Default Project' - Add improved error messages showing available projects when project not found - Update documentation and examples to include ZILLIZ_PROJECT_NAME configuration - Maintain backward compatibility by defaulting to 'Default Project' when not specified
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR adds support for configuring the Zilliz Cloud project name via the
ZILLIZ_PROJECT_NAMEenvironment variable, addressing the issue where "Default Project" was previously hardcoded.Problem
Previously, when auto-resolving cluster addresses from a Zilliz Cloud token, the system was hardcoded to look for a project named "Default Project". This limitation prevented users from using different project names in their Zilliz Cloud accounts.
Solution
ZILLIZ_PROJECT_NAMEenvironment variableClusterManager.getAddressFromToken()to accept an optional project name parameterZILLIZ_PROJECT_NAMEenvironment variableChanges
packages/core/src/vectordb/zilliz-utils.ts: UpdatedgetAddressFromTokenmethod to support configurable project namespackages/mcp/src/config.ts: AddedzillizProjectNameto configuration interface.env.example: Added example configuration forZILLIZ_PROJECT_NAMEdocs/getting-started/environment-variables.md: Documented the new environment variablepackages/mcp/README.md: Added configuration example for the new variableTesting
pnpm buildZILLIZ_PROJECT_NAMEis not set, the system defaults to "Default Project" as beforeBreaking Changes
None - this change is fully backward compatible.
Related Issues
This addresses the limitation where users couldn't specify custom project names when using Zilliz Cloud's auto-resolution feature.